Issue311 improve hook searching #613

steniobhz · 2024-10-04T16:26:44Z

Documentation for the Hook Search API (Listeners and Routes)

Available Endpoints

Search Listeners

Endpoint: /registrations/listeners
HTTP Method: GET
Description: Searches for all Listeners whose destination field contains the provided query string in the q parameter.

Search Routes

Endpoint: /registrations/routes
HTTP Method: GET
Description: Searches for all Routes whose destination field contains the provided query string in the q parameter.

Query Parameter

Both endpoints support the q query parameter, which is used to filter the search results.

q: A string to search for within the destination field of Listeners or Routes.

Example Request:
GET /registrations/listeners?q=myDestination
GET /registrations/routes?q=myDestination

Response Structure
Example Response - Searching for Listeners:

{
    "listeners": [
        "listener1",
        "listener2",
        "listener3"
    ]
}

Example Response - Searching for Routes:

{
    "routes": [
        "route1",
        "route2",
        "route3"
    ]
}

Key Features

Separate Endpoints for Listeners and Routes: The API provides distinct endpoints for Listeners and Routes searches, ensuring optimized search results based on specific hook types.
String-Based Search: The API looks for matches in the destination field of both Listeners and Routes. It searches for any substring match rather than an exact match, making the search more flexible.
Optimized Search Logic: The API uses efficient search mechanisms internally to quickly find results across registered listeners or routes, reducing response time even with large datasets.

Example Workflow

A client wants to find all Listeners with a destination that contains the string "myDestination". They make the following request:
GET /registrations/listeners?q=myDestination
The API returns a JSON object containing the identifiers of matching Listeners:

{
    "listeners": [
        "listener1",
        "listener2"
    ]
}

If no Listeners match the query, the API responds with a 404 error:

{
    "error": "No listeners/routes found matching the query."
}

Add the tests to cover new implementations lto cover HookHandlerSearch

mcweba

As discussed on the phone, you should also add some integration tests in the gateleen-test module. Where is the documentation of this new API feature?

gateleen-hook/src/main/java/org/swisspush/gateleen/hook/HookHandler.java

gateleen-hook/src/test/java/org/swisspush/gateleen/hook/HookHandlerTest.java

gateleen-hook/src/main/java/org/swisspush/gateleen/hook/HookHandler.java

gateleen-hook/src/test/java/org/swisspush/gateleen/hook/HookHandlerTest.java

Add new tests for HookHandler Create testes with storage

- Verifies successful listener search when multiple listeners are present in storage. - Ensures correct retrieval of a single listener from storage. - Tests failure case when searching for a non-existent listener among multiple listeners. - Ensures proper handling of search when no listeners are registered in storage.

…istener is found for a given query parameter.

…eners registered. - Test for handling searches with no matching listeners, returning an empty list. - Test for handling searches when no listeners are registered, ensuring an empty list is returned. - Fix hookHandler Search

…tory. It checks if the destination of each item contains the query string (queryParam), adding matching items to the result.

- improve listeners tests

codecov · 2024-10-17T12:34:27Z

Codecov Report

Attention: Patch coverage is 54.28571% with 16 lines in your changes missing coverage. Please review.

Project coverage is 48.87%. Comparing base (45f39c1) to head (4fdab6c).
Report is 23 commits behind head on develop.

Files with missing lines	Patch %	Lines
.../java/org/swisspush/gateleen/hook/HookHandler.java	54.28%	14 Missing and 2 partials ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             develop     #613      +/-   ##
=============================================
+ Coverage      48.44%   48.87%   +0.42%     
- Complexity      1862     1892      +30     
=============================================
  Files            238      238              
  Lines          11953    12049      +96     
  Branches        1261     1278      +17     
=============================================
+ Hits            5791     5889      +98     
+ Misses          5659     5653       -6     
- Partials         503      507       +4

Flag	Coverage Δ
	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mcweba · 2024-10-17T13:58:23Z

gateleen-hook/README_hook.md


+```
+GET http://myserver:7012/gateleen/server/listenertest/_hooks/listeners/listener/1?q=testQuery


This is not how listener hooks are searched. The URL does not contain the listener-ID.

mcweba · 2024-10-17T14:00:02Z

gateleen-hook/README_hook.md

+```json
+{
+  "listeners": [
+    {


The content of searching listeners and routes is not an array of objects (with destination, methods properties) but an array containing a list of names (strings). How did you even get this response?

mcweba · 2024-10-17T14:01:11Z

gateleen-hook/src/main/java/org/swisspush/gateleen/hook/HookHandler.java

+    private static final String CONTENT_TYPE_JSON = "application/json";
+    private static final String LISTENERS_KEY = "listeners";
+    private static final String ROUTES_KEY = "routes";
+    private static final String DESTINATION_KEY = "destination";


Your newly created DESTINATION_KEY static variable is not used

mcweba · 2024-10-17T14:03:14Z

gateleen-hook/src/main/java/org/swisspush/gateleen/hook/HookHandler.java

@@ -569,6 +577,22 @@ public boolean handle(final RoutingContext ctx) {
            }
        }

+        // 1. Check if the request method is GET
+        if (request.method() == HttpMethod.GET) {
+            String uri = request.uri();


Extract var requestUri = request.uri(); only once in the handle method. It is already done for PUTand DELETE requests. We should optimize this.

mcweba · 2024-10-17T14:07:30Z

gateleen-hook/src/main/java/org/swisspush/gateleen/hook/HookHandler.java

+        // 1. Check if the request method is GET
+        if (request.method() == HttpMethod.GET) {
+            String uri = request.uri();
+            String queryParam = request.getParam("q");


Using any other query params than q in GET requests should result in a 400 Bad Request and not just return all listeners/hooks. Also create tests to verify this.

mcweba · 2024-10-17T14:37:27Z

gateleen-test/src/test/java/org/swisspush/gateleen/hook/RouteListingTest.java

+
+        // Register a route with a different query param
+        String differentQueryParam = "differentQuery";
+        TestUtils.registerRoute(requestUrlBase + routePath + "?q=" + differentQueryParam, targetUrlBase, new String[]{"GET", "POST"}, null, true, true);


Query param in PUT request for route registration. This does not work

mcweba · 2024-10-17T14:38:03Z

gateleen-test/src/test/java/org/swisspush/gateleen/hook/RouteListingTest.java

+        TestUtils.registerRoute(requestUrlBase + routePath + "?q=" + differentQueryParam, targetUrlBase, new String[]{"GET", "POST"}, null, true, true);
+
+        // Send GET request with non-matching query param
+        given().queryParam("q", nonMatchingQueryParam)


Invalid uri

mcweba · 2024-10-17T14:38:16Z

gateleen-test/src/test/java/org/swisspush/gateleen/hook/RouteListingTest.java

+                .body("routes", Matchers.empty());
+
+        // Validate response
+        checkGETStatusCodeWithAwait(requestUrl, 200);


Verify response

mcweba · 2024-10-17T14:38:32Z

gateleen-test/src/test/java/org/swisspush/gateleen/hook/RouteListingTest.java

+        // No routes registered
+
+        // Send GET request with a query param
+        given().queryParam("q", queryParam)


invalid uri

mcweba · 2024-10-17T14:38:49Z

gateleen-test/src/test/java/org/swisspush/gateleen/hook/RouteListingTest.java

+                .body("routes", Matchers.empty());
+
+        // Validate response
+        checkGETStatusCodeWithAwait(requestUrl, 200);


Verify response

steniobhz added 2 commits September 30, 2024 20:04

create a method to search routes and listeners by parameter "q"

ae01c87

Fix null pointer in HookHandler

9e39c83

Add the tests to cover new implementations lto cover HookHandlerSearch

mcweba requested changes Oct 7, 2024

View reviewed changes

steniobhz added 9 commits October 9, 2024 21:44

Fix tests and implement more validations.

d9f1c76

Add new tests for HookHandler Create testes with storage

Add an integration test at ListenerTest

922708c

Fix return method

2f712c0

Added test for hookHandleSearch to verify behavior when no matching l…

a0161a2

…istener is found for a given query parameter.

Implemented a search mechanism that iterates over the provided reposi…

55ab41b

…tory. It checks if the destination of each item contains the query string (queryParam), adding matching items to the result.

Fix error in mock tests

8feb386

- add tests for Route

4004646

- improve listeners tests

steniobhz force-pushed the Issue311_Improve-hook-searching branch from 4fdab6c to 4004646 Compare October 17, 2024 12:49

Update README_hook.md

64e6905

steniobhz requested a review from mcweba October 17, 2024 12:54

mcweba requested changes Oct 17, 2024

View reviewed changes

steniobhz added 2 commits October 17, 2024 18:10

add validation to return 400 instead 404 search parameter != "q" or null

6aeec5c

add testes to check if parameter is valid

4f7f4ff

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue311 improve hook searching #613

Issue311 improve hook searching #613

steniobhz commented Oct 4, 2024 •

edited

Loading

mcweba left a comment

codecov bot commented Oct 17, 2024 •

edited

Loading

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024

mcweba Oct 17, 2024


		```
		GET http://myserver:7012/gateleen/server/listenertest/_hooks/listeners/listener/1?q=testQuery

Issue311 improve hook searching #613

Are you sure you want to change the base?

Issue311 improve hook searching #613

Conversation

steniobhz commented Oct 4, 2024 • edited Loading

Documentation for the Hook Search API (Listeners and Routes)

mcweba left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 17, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steniobhz commented Oct 4, 2024 •

edited

Loading

codecov bot commented Oct 17, 2024 •

edited

Loading